home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / upchk23f.zip / UPCHECK.DOC < prev    next >
Text File  |  1992-01-21  |  14KB  |  391 lines
  1.  
  2.                             UPCHECK DOCUMENTATION
  3.                                 Version 2.3f
  4.                                  Written By
  5.    
  6.                                Chris Phillips
  7.  
  8.                              --------------------
  9.  
  10.  
  11. DISCLAIMER
  12. ----------
  13.  
  14. This software is provided "As Is".  All responsibility and risk, in
  15. installing and running this program and its associated files, is taken on 
  16. completely by the person using this software.  This software comes without
  17. any warranty, expressed or implied.  If you do not agree with the above,
  18. please don't use this software.
  19.  
  20.  
  21. INTRODUCTION
  22. ------------
  23.  
  24. UPCHECK is a utility written for SPITFIRE Bulletin Board Systems to provide
  25. Sysops a quick and easy method of testing uploaded files.  UPCHECK will not
  26. only test uploaded files for viruses and compression integrity, but also
  27. add the BBS's unique ZIP comment, if desired.   In addition to ZIP, UPCHECK
  28. v2.3f also provides support for ARC, LZH, PAK and ARJ file compression 
  29. techniques.  It should be noted, that if you want UPCHECK to add your ZIP 
  30. comment you must have the ZIPCOMNT.EXE program from ZIP-KIT9.ZIP, if you want
  31. UPCHECK to test .GIF files you must have the TESTGIF.EXE program from
  32. GIFT40B.ZIP, and if you want UPCHECK to test .TD0 files (Teledisked files)
  33. you must have the TDCHECK.EXE program from TDCHK110.ZIP.  All these files
  34. are available from most BBS's.
  35. Much thanks must go out to Mike Woltz for writting SPITFIRE, the best in
  36. Bulletin Board Software!
  37.  
  38. CONFIGURING UPCHECK
  39. --------------------
  40.  
  41. UPCHECK can be used to check uploaded files immediately after they
  42. are uploaded and while the caller is still online or after the
  43. caller has logged off and SPITFIRE is in between callers.  One of
  44. the first things you must decide is in what mode you intend to run
  45. UPCHECK.  If UPCHECK is to be run online, the SFEXTUP<x>.BAT will
  46. require modification and if UPCHECK is to be run in between callers,
  47. a SFINIT.BAT must be set up.  Sample batch files are included in
  48. the UPCHECK23.ZIP distribution package.
  49.  
  50. *NOTE*
  51. UPCHECK can only be run online when a caller uses an external protocol!
  52.  
  53. Regardless of how you decide to run UPCHECK, unzip the distribution
  54. package into the directory from which you intend to run UPCHECK.
  55.  
  56. You will notice a file included in UPCHECK23.ZIP called UPCHKCFG.EXE.
  57.  
  58. From the DOS prompt, type:
  59.  
  60. UPCHKCFG
  61.  
  62. to configure UPCHECK to run on your system.
  63.  
  64.                                                           Page 2
  65.                                                           
  66.                                                           
  67.                                                           
  68.  
  69.             Configuration for Upcheck Ver 2.3f
  70.  
  71.  
  72.  
  73.  
  74.                     (P)rograms Setup
  75.                     (A)dditional Set parameters
  76.                     (U)pload Area
  77.                     (F)file Conversion
  78.                     (S)how Current Configuration
  79.                     (Q)uit w/Save
  80.                     (X) Quit wo/Save
  81.  
  82. When the (P)rograms Setup option is selected, prompts will appear asking
  83. whether the feature displayed should be enabled, ie:
  84.  
  85. Enable ZIP Y/(N) ?
  86.  
  87. *Note
  88. This will allow you to enable processing of .ZIP files.
  89.  
  90. If you pick "Y" you will then be prompted with:
  91.  
  92. Path to PKUNZIP including extension
  93. Was   C:\UTIL\PKUNZIP.EXE   Hit Enter to accept
  94.  
  95. You will then be prompted for the following files:
  96.  
  97. TDCHECK - TDCHECK.EXE     Teledisked File Checker
  98. GIFTEST - TESTGIF.EXE    .GIF File Checker *
  99. ZIPCOMNT - ZIPCOMNT.EXE   ZIP Commenter *
  100. ARC - PKXARC.COM         .ARC Program
  101. LZH - LHA.EXE            .LHA Program
  102. ARJ - ARJ.EXE            .ARJ Program
  103. PAK - PAK.EXE            .PAK Program
  104. SCAN - SCAN.EXE          .Virus Scanner *
  105.  
  106. Any of these programs maybe turned on or off.
  107.  
  108. Files followed by a * will also prompt you with the following:
  109.  
  110. Command Line Parameters to use
  111. Was   *   Hit Enter to accept
  112.  
  113. *Note
  114. Another new feature of Upcheck ver 2.3f is to allow the user to specify 
  115. different command line parameters to 3 of the programs that are called by
  116. UPCHECK. If for example you use a program other that ZIPCOMNT.EXE you may
  117. wish to specify something other than a * as it's parameter. As you may 
  118. have already noticed , * is the default parameter for use with ZIPCOMNT.EXE.
  119. In the same manner you may also use different parameters with your virus
  120. scanner and your gif tester. 
  121. IMPORTANT: Whatever you specify for your alternate comment program the 
  122. parameters must indicate to that program to do ALL ZIPs in the current
  123. directory.
  124.  
  125. When the (A)dditional Setup parameters option is selected you will be
  126. prompted for the following:
  127.  
  128. Use Ramdisk for Work area ? Y/(N) *See note below about using this option!
  129.  
  130. *Note
  131. UPCHECK now allows the user to use a Ramdisk as a "work" area. This is 
  132. especially useful when You have plenty of memory and would like to cut
  133. down unnecessary wear and tear on your hard disk. When Extracting archives
  134. upcheck would extract them to the ramdisk for scanning by your preferred
  135. virus scanner. YOU MUST ENSURE THAT YOU HAVE A LARGE ENOUGH RAMDISK ! If
  136. there is insufficient disk space available then NO ERROR will occur. I 
  137. would recommend at least 1-2 megs. Only 1 archive at a time will occupy
  138. space in the ramdisk. ie. If four ZIPs are uploaded, they will be extracted 
  139. only one at a time into the ramdisk. any subsequent archives within the 
  140. file will still be extracted so this could eat up the space rather quickly.
  141. If there are any problems encountered with this feature please let me know.
  142. As far as I can tell , Upcheck will still function normally but be unable to 
  143. scan the entire contents of an extremely large archive. 
  144.  
  145. If you pick "Y" you will then be prompted with:
  146.  
  147. Ramdisk Drive Designation
  148. Was  D:  Hit Enter to accept
  149.  
  150. You will then be prompted with the following:
  151.  
  152. Enter Path for BAD FILES to be moved to
  153. Was  C:\BAD  Hit Enter to accept
  154.  
  155. *Note
  156. This is where you want files that have failed for one reason or
  157. another to be moved to, this path MUST exist!
  158.  
  159. Path and Name of The List of executable files not to check
  160. Was C:\UTIL\NOCHECK.DAT  Hit Enter to accept
  161.  
  162. *Note
  163. NOCHECK.DAT is a file that you may create to list files that reside
  164. in the directory from where UPCHECK is executed that you wish to exclude
  165. from integrity checking.  For instance, if you are running UPCHECK online
  166. from your external protocol path, you might want to include such files as
  167. DSZ.EXE, LYNX.EXE, JMODEM.EXE etc. in your NOCHECK.DAT file.  A sample 
  168. NOCHECK.DAT is included in the distribution package.
  169.  
  170. Path and Name of Log File
  171. Was  C:\SF\WORK\HEYSYSOP.LOG  Hit Enter to accept
  172.  
  173. *Note
  174. This is the .LOG file which UPCHECK will write to telling you what files
  175. were checked and if any files failed.
  176.  
  177. ONLINE mode Y/(N)?
  178.  
  179. *Note
  180. This is telling UPCHECK to write to the port so that the caller knows what
  181. is going on, otherwise the caller may think your boards has "hung" when
  182. testing a large file or running on a slow system.
  183.  
  184. If you pick "Y" you will then be prompted with:
  185.  
  186. ComPort to use { 1-4 } 
  187.  
  188. When the (U)load Area option is selected you will be prompted for 
  189. the following:
  190.  
  191. Path to UPLOAD file area {hit enter to disable moving files}
  192.  
  193. *Note
  194. Use this feature if you are running UPCHECK from the SFINIT.BAT file so
  195. that the files being tested are moved from your "private" upload area to
  196. a public area. File moving should be disabled if you are running online!
  197. The description will also be moved from the original SFFILES.BBS to the
  198. SFFILES.BBS in the area you you specify here.  If no UPLOAD file area is
  199. entered, when UPCHECK is completed its testing, the files will not be
  200. moved but remain in the current directory.
  201.  
  202. When the (F)ile Conversion option is selected you will be prompted
  203. for the following:
  204.  
  205. Convert All Archive Formats to a specific Format ? Y/(N)
  206.  
  207. *Note
  208. This will allow you to convert any .ARJ, .PAK, etc...to a single
  209. compression format that you board uses.
  210.  
  211. If you do a (S)how Current Configuration you will see the following:
  212.  
  213.  
  214. Path to PKUNZIP  : C:\UTIL\PKUNZIP.EXE
  215. Path to ZIPCOMNT : C:\UTIL\ZIPCOMNT.EXE executed with *
  216. Path to PKXARC   : C:\UTIL\PKXARC.EXE
  217. Path to PAK      : C:\UTIL\PAK.EXE
  218. Path to LHARC    : C:\UTIL\LHA.EXE
  219. Path to ARJ      : C:\UTIL\ARJ.EXE
  220. Path to SCAN     : C:\UTIL\SCAN.EXE executed with /nomem /a
  221. Path to TDCHECK  : Disabled
  222. Path to GIFTEST  : C:\UTIL\TESTGIF.EXE executed with
  223. Path to Log file : C:\SF\WORK\HEYSYSOP.LOG
  224. Path to NOCHECK file : C:\UTIL\NOCHECK.DAT
  225. Ramdrive For Work Area :Disabled
  226. Location for Bad Files : C:\BADFILES
  227. Convert Files    : Disabled
  228. ONLINE use : FALSE
  229. Path to UPLOAD area :Moving Files Has Been Disabled
  230.  
  231. *Note
  232. This will of course change to suit what you setup.
  233.  
  234. You must make sure that your paths to all files and directories listed in 
  235. the UPCHKCFG program are correct!
  236.  
  237.  
  238.                                                            Page 3
  239.  
  240.                                                           
  241.  
  242. RUNNING UPCHECK ONLINE
  243. ----------------------
  244.  
  245.    When using UPCHECK online, it can only be configured to check files
  246. that are uploaded using external protocols.  You will need to modify 
  247. your SFEXTUP<X>.BAT to include the additional line:
  248.  
  249.    UPCHECK
  250.    
  251. after the upload is completed and before the files are moved or
  252. copied to the uploaded files directory.  A sample, SFEXTUPA.BAT using
  253. ZModem file transfer protocol might look like this:
  254.  
  255.  
  256. @ECHO OFF
  257. CD\SF\EXT
  258. DSZ %2 handshake on pB8192 pd0 rz -m -r -rr
  259. UPCHECK L
  260. MUV %3 %4
  261. REM The above "MUV" command must not be used in SPITFIRE v3.2 or higher!
  262. CD\SF
  263. ECHO ON
  264.  
  265.                                                                  Page 4
  266.  
  267.  
  268. A similar example using batch uploads might appear as below:
  269.  
  270. @ECHO OFF
  271. CD\SF\EXT
  272. DSZ %2 handshake slow pB8192 pd0 rz -m -r -rr
  273. UPCHECK L
  274. IF EXIST %3 MUV %3 %4
  275. IF EXIST %5 MUV %5 %4
  276. IF EXIST %6 MUV %6 %4
  277. IF EXIST %7 MUV %7 %4
  278. IF EXIST %8 MUV %8 %4
  279. IF EXIST %9 MUV %9 %4
  280. REM The above "MUV" commands must not be used in SPITFIRE v3.2 or higher
  281. CD\SF
  282. ECHO ON
  283.  
  284. MUV is Buffalo Creek's file moving utility.  If MUV is not available
  285. the files could be copied to the upload directory and then erased 
  286. from the external protocol directory just as easily.
  287.  
  288. Remember when using UPCHECK in the online mode to specify UPCHECK's
  289. configuration for ONLINE use as TRUE and designate the appropriate Comm 
  290. Port.
  291.  
  292.  
  293. RUNNING UPCHECK OFFLINE
  294. -----------------------
  295.  
  296. To run UPCHECK between callers on the BBS, create or modify your
  297. SFINIT.BAT to include the following:
  298.  
  299. @ECHO OFF
  300. REM CHANGE TO YOUR PRIVATE UPLOAD DRIVE AND DIRECTORY
  301. CD\PRIVUP
  302. REM RUN UPCHECK IN THIS AREA
  303. UPCHECK
  304. REM CHANGE BACK TO YOUR SPITFIRE HOME DRIVE AND DIRECTORY
  305. CD\SF
  306. ECHO ON
  307.  
  308. Remember when using UPCHECK in the offline mode to specify UPCHECK's
  309. configuration for ONLINE use as FALSE and designate the appropriate 
  310. upload files directory.
  311.  
  312.  
  313.                                                               Page 5
  314.  
  315.  
  316.  
  317. COMMAND LINE PARAMETERS
  318. -----------------------
  319.  
  320. At anytime, you need help regarding usage of UPCHECK's command line
  321. parameters, type the following at the DOS prompt:
  322.  
  323. UPCHECK ?
  324.  
  325. This will provide information on the various command line parameter
  326. options that are available with UPCHECK.
  327.  
  328. In addition to ? (help), UPCHECK uses the following command line parameters:
  329.  
  330. UPCHECK U=Directory
  331.  
  332. would move file(s) that pass UPCHECK's testing to the directory specified
  333. here.  The directory must be a valid DOS directory.  Using UPCHECK U=
  334. without any directory specified checks files in the current directory
  335. without moving them when testing is completed.
  336.  
  337. UPCHECK L 
  338.  
  339. would turn on logging of each file that is tested
  340.  
  341. UPCHECK P=#
  342.  
  343. where # indicates the comm port that is to be used.  Note that the ONline
  344. use is also set by this command.
  345.  
  346. Although, all command line parameters can be used together in any order,
  347. the use of the P=<#> command will not allow files to be moved.  So 
  348.  
  349. UPCHECK L U=C:\SF\NEWUPS P=2
  350.  
  351. would set the ONline mode, therefore, no files would be moved.
  352.  
  353. Also note, using command line parameters with UPCHECK overrides the 
  354. appropriate settings established with UPCHKCFG.
  355.  
  356. By using the command parameter U=, it is possible to run UPCHECK from the
  357. DOS command line so that it checks the files but does not move them.  To
  358. do this, simply run UPCHECK from the directory you wish to have checked
  359. using the following command:
  360.  
  361. UPCHECK L U=
  362.  
  363.  
  364. If you have any special requirements please 
  365. leave mail for me on The HOBBIT HOLE BBS as listed below.
  366.  
  367. REGISTRATION
  368. ------------
  369.  
  370. CHECKUP is NOT crippled in any way.  Nor is it timed to cease operating
  371. after a pre defined period of time.  The shareware version operates
  372. exactly as the registered version.  The only difference between the
  373. shareware version and the registered version is that the registered
  374. version will display: Registered to <Sysop's name> of <BBS name> and
  375. the shareware version denotes it is an unregistered version.
  376.  
  377. If you find this software beneficial please send the $10 registration fee
  378. to:
  379.  
  380.                         Chris Phillips
  381.                        61 Old Milton Rd
  382.                       Rochester N.H. 03868
  383.  
  384. If you experience any problems or have any suggestions or requirements
  385. please contact either myself or the SysOp of:
  386.  
  387.                       The Hobbit Hole BBS
  388.                         (207)490-2159
  389.                        300-38,400 Bauds
  390.               Using a US Robotics Dual Standard Modem                  
  391.